home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 001 / but201.arc / BUTLER.DOC < prev    next >
Text File  |  1986-03-28  |  10KB  |  193 lines
  1. ──────────────────────────────────────────────────────────────────────────────
  2.                    ModemButler version two point zero one
  3. ──────────────────────────────────────────────────────────────────────────────
  4.                   communications served on a silver platter
  5. ──────────────────────────────────────────────────────────────────────────────
  6.                documentation revised on Friday March 28, 1986
  7.  
  8. TEMPORARY DOCUMENTATION
  9.  
  10. ─Invoking ModemButler Version 2.01────────────────────────────────────────────
  11.  
  12. from DOS, type:
  13. BUTLER CMNDFILE[.EXT] HISTFILE[.HIS] {str1} .. {str7}
  14.        │                 │                 └───────────┐
  15. ╔══════╧═══════════╗ ╔═══╧═════════════════╗  ╔════════╧══════════════════╗
  16. ║ the name  of the ║ ║ name of the history ║  ║ up to 7  strings (without ║
  17. ║ command file you ║ ║ file    for    this ║  ║ quotes or  spaces) can be ║
  18. ║ wish to execute. ║ ║ session. If omitted ║  ║ specified.  The 7 will be ║
  19. ║ EXT    optional, ║ ║ CMNDFILE.HIS     is ║  ║ placed  in  parameters |1 ║
  20. ║ .BUT used  if no ║ ║ used.   If  no  EXT ║  ║ thru  |7.  These  strings ║
  21. ║ EXT supplied.    ║ ║ specified,     .HIS ║  ║ are optional.             ║
  22. ╚═Command Filename═╝ ║ used.               ║  ╚══Setting Parameters═══════╝
  23.                      ╚═History Filename════╝
  24.  
  25.  
  26. ─Conventions Used in this Listing─────────────────────────────────────────────
  27.  
  28. {num}             parameter required is a number
  29. {label}           a string of characters (not including a space) "marking"
  30.                   a section of your command file.  Lower-case characters
  31.                   are different than upper-case (i.e. LABEL, label and Label
  32.                   are all different labels)
  33. {filename}        parameter required is a legal file name
  34. /                 denotes a choice of parameters for this command
  35. \
  36. {char}            one alphanumeric character (a letter, number or symbol)
  37.                     is required
  38. {HH:MM:SS}        time value in DOS standard 24 hour format.  Separate with
  39.                     colons, no spaces
  40. {str}             a string, delimited by " is required (i.e., "Hello" is
  41.                     legal, Hello is not).  The placement of a { in a string
  42.                     will cause a CR (carrage return) to be substituted in its
  43.                     place.  This means that you can't use the character {
  44.                     in a string except to signify a return
  45. {ph no}           a series of characters ( - () and modem commands are legal)
  46.                     which will be sent to the modem with the dialing command
  47. {drive/path}      a string without quotes which specifies a drive and/or path
  48.                     (i.e., B:\TURBO\BUTLER or A:)
  49.  
  50.  
  51. ─Brief Listing of Commands────────────────────────────────────────────────────
  52.  
  53. .      A period followed by anything is disregarded by BUTLER.  This is used
  54.        for the purposes of documenting your command files
  55.        NOTE: this character can be changed through the BUTINST utility
  56.  
  57. {      This symbol will be replaced with a Carriage Return (CR) value when
  58.        found in the command file.  As a consequence, this character cannot
  59.        be represented in a string unless you change to something else through
  60.        BUTINST
  61.        NOTE: this character can be changed through the BUTINST utility.
  62.  
  63. ]{label}  This is the syntax for a label declaration.  For rules regarding the
  64.           naming of labels, see "Conventions" section above.  To see what
  65.           labels are good for, see the GOTO command below.  This statement
  66.           alone will not have any visible effect upon command file execution.
  67.           NOTE: this character (]) can be changed through the BUTINST utility.
  68.  
  69. |{char}     When placed anywhere in a command file, will cause the |{char} to
  70.             be replaced with the corresponding parameter.  The parameter and
  71.             the {char}, which I'll call a trigger, can be specified in
  72.             three ways:
  73.               -  through the command line, |1 through |7 can be specified.
  74.               -  through the ASK command (see below) any string can be
  75.                  attached to any trigger (numeric or a letter) interactively
  76.               -  through the ASSIGN command (see below) any string can be
  77.                  set to any trigger in the command file.
  78.             Up to twenty trigger/parameter combinations can be specified,
  79.             using whatever trigger symbols you desire.
  80.  
  81. ASK {char} {str}    Places BUTLER in an interactive mode.  A small window is
  82.                     opened on screen, and {str} is displayed (as a prompt).
  83.                     The operator must then enter a string (quotes aren't
  84.                     needed as delimiters) which is placed in the parameter
  85.                     corresponding to (char)
  86.  
  87. ASSIGN {char} {str}  Assigns parameter {str} to trigger {char}
  88.  
  89. BAUD {num}     Change baud rate  [default 1200]
  90.  
  91. BEEP {num}     Beeps the speaker for approximately 3 seconds in the frequency
  92.                {num} Hz. (Hertz)
  93.  
  94. CHARDELAY {num}     Set the delay between characters in Ascii file transfers
  95.                     to {num}
  96.  
  97. CHDIR {drive/path}  Changes the current path/drive to the specified
  98.                     drive/path
  99.  
  100. DATABITS {num}  Change data bits  [default 8]
  101.  
  102. DIAL command:
  103. ModemButler version 2.01 represents a full rewriting of the DIAL subcommand.
  104. The DIAL command is now based upon a nine number redial circular queue, or
  105. list.  What this basically means is that with one command you can dial
  106. up to nine systems in a row until one answers.  For example, you can say:
  107.   DIAL 333-1212 QMODEM 5 6 7
  108. This will do the following:  first, it will add the number 333-1212 to the
  109. queue.  Then ModemButler will attempt to read QMODEM.FON from the current
  110. drive/path because it finds QMODEM on the command line.  It will add Qmodem
  111. phone book entries #5, #6 and #7 to the queue.  Since there are no more
  112. numbers on the line, Butler will proceed to dial all 4 until it connects with
  113. one.  A DIAL command without any parameters will just dial whatever is left
  114. in the queue (numbers are deleted from the queue after a connection is made).
  115.  
  116. DIAL {ph no1} ... {ph no9}
  117.         and/or QMODEM {num1} ... {num9}
  118.  
  119. DOWNLOAD command:
  120. same subcommands as the UPLOAD command, except that NO {filename} should be
  121. specified for YMODEM, BATCH, TELINK or MODEM7 protocol.  The sending system
  122. specifies the sending filename as part of the transfer.  NOTE:  Please see
  123. UPLOAD command below.
  124.  
  125. ECHO / ON      Turn echo on (half duplex)
  126.      \ OFF     Turn echo off (full duplex) [default off]
  127.  
  128. GOTO {label}   This will cause ModemButler to "search" for the label character
  129.                followed by {label}.  File execution will continue from that
  130.                point.  The GOTO can be issued from before or after the label
  131.                named.  If no {label} is found, an error is issued and command
  132.                file execution is halted.
  133.                By the way, since ModemButler searches in sequential order
  134.                from the first to the last line in the command file for the
  135.                matching label, it can take longer to reach a label at the
  136.                end (as opposed to the beginning) of a command file.
  137.  
  138. HANG  Hang up the phone.
  139.  
  140. LINEDELAY {num}     Set the delay between lines in Ascii file transfers to
  141.                     {num}
  142.  
  143. NOTE {str}       Displays NOTE: followed by {str} in the message window
  144.                  on-screen
  145.  
  146. PACING {char}    Set the Pacing character in Ascii file transfers to {char}
  147.  
  148. PORT {num}     Comm port to use  [default 1]
  149.  
  150. PARITY {char}   Change parity  [default N]
  151.  
  152. PULSE / OFF     Will DIAL using tone prefix
  153.       \ ON      Will DIAL using pulse prefix  [default]
  154.  
  155.      / CHAR {str}     Send {str}
  156. SEND \ ASCII {num}    Send Ascii code {num}
  157.  
  158. Please note that if you wish to SEND a cr (carrage return) after a string,
  159. just place a { in the string (i.e., SEND "NAME{").  If you want to send just
  160. a return, you can say SEND "{".
  161.  
  162. STOPBITS {num}  Change stop bits  [default 1]
  163.  
  164. UPLOAD command:
  165.   / CRC        Set error checking to CRC
  166.     CHK        Set error checking to Checksum [default]
  167.     KERMIT     Not operational yet!
  168.     YMODEM {filename}   Upload file using Ymodem protocol
  169.     BATCH {filename} Upload file(s) matching {filename} (which can have *'s
  170.                      and ?) using the Ymodem Batch mode protocol (not
  171.                      supported everywhere).  Using BATCH, you can upload more
  172.                      than one file with one command on systems supporting it.
  173.                      Good for transfering a whole disk (*.* as {filename})
  174.                      between two BUTLER equipped computers.
  175.     TELINK {filename}   Upload file {filename} using Telink protocol
  176.   \ MODEM7 {filename}   Upload file {filename} using Modem7 protocol
  177.  
  178.      / FOR {str}     Wait until {str} received
  179. WAIT   ASCII {num}   Wait until Ascii value {num} received
  180.        TIME {HH:MM:SS}  Wait until system time is {HH:MM:SS}
  181.      \ LINES {num}   Wait until {num} lines (cr sequences) received
  182.  
  183. ──────────────────────────────────────────────────────────────────────────────
  184.  
  185. modem butler version two point zero one beta copyright 1985,86 Andrew Brenner
  186.  
  187.                 504 Glen Court
  188.                 Oceanside NY 11572
  189.                 (516) 764-5248 (voice)
  190.                 (516) 741-6914 (the railroad bbs - 300, 1200, 2400 baud)
  191.  
  192. ──────────────────────────────────────────────────────────────────────────────
  193.